feat: add C implementation for `math/base/special/minmax` #6296

Neerajpathak07 · 2025-03-22T16:57:44Z

Progresses #649,
Resolves #2106.

Description

What is the purpose of this pull request?

This pull request:

adds C implementation for math/base/special/minmax

#include <stdint.h>

double min;
double max;

stdlib_base_minmax( 4.0, -5.0, &min, &max );

Related Issues

Does this pull request have any related issues?

This pull request:

progresses [RFC]: Add C implementations to base special math functions (tracking issue) #649
resolves [RFC]: Add C implementation for @stdlib/math/base/special/minmax #2106

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines

@stdlib-js/reviewers

stdlib-bot · 2025-03-22T17:40:47Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/minmax	$\color{green}253/253$ $\color{green}+100.00\%$	$\color{green}17/17$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}253/253$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

Neerajpathak07 · 2025-03-22T18:25:39Z

lib/node_modules/@stdlib/math/base/special/minmax/src/addon.c

+* @param info   callback data
+* @return       Node-API value
+*/
+static napi_value addon( napi_env env, napi_callback_info info ) {


Have kept the addon logic as this for now and going through https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/napi to have an idea for a utility for void functions.
for this file I have refactored this code-block.

Turns out we can convert it a very simplified fashion like:-

static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 ); STDLIB_NAPI_ARGV_DOUBLE( env, y, argv, 1 ); STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, z, zlen, argv, 2 ); double min; double max; stdlib_base_minmax( x, y, &min, &max ); double *op = (double *)z; op[ 0 ] = min; op[ 1 ] = max; return NULL; }

just searching for an utility that can accumulate void function.

something similar was also done in rempio2

@Neerajpathak07 You can do something like this:

In addon.c, you can have:

#include "stdlib/math/base/special/minmax.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_double.h" #include "stdlib/napi/argv_float64array.h" #include <node_api.h> /** * Receives JavaScript callback invocation data. * * @param env environment under which the function is invoked * @param info callback data * @return Node-API value */ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 ); STDLIB_NAPI_ARGV_DOUBLE( env, y, argv, 1 ); STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, out, outlen, argv, 2 ); stdlib_base_minmax( x, y, &out[ 0 ], &out[ 1 ] ); return NULL; } STDLIB_NAPI_MODULE_EXPORT_FCN( addon )

And, for native.js:

function minmax( x, y ) { var out = new Float64Array( 2 ); addon( x, y, out ); return [ out[ 0 ], out[ 1 ] ]; }

@gunjjoshi Bingo!!
I had drafted a similar logic earlier but was confused on how to go about the void function. But you just clarified it thank you soo much!!

Neerajpathak07 · 2025-03-22T20:01:19Z

@gunjjoshi LMK your opinion on this!!

Neerajpathak07 · 2025-03-23T16:23:27Z

Not sure though why only C examples CI tests are failing for #include <node_api.h> and not for any other files.

anandkaranubc · 2025-05-11T00:35:02Z

/stdlib merge

stdlib-bot · 2025-05-11T00:37:06Z

/stdlib merge

@anandkaranubc, the slash command failed to complete. Please check the workflow logs for details.

View workflow run

Signed-off-by: Karan Anand <[email protected]>

anandkaranubc · 2025-05-11T00:37:35Z

/stdlib merge

anandkaranubc · 2025-05-11T00:45:32Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+#include <stdlib.h>
+
+/**
+* Evaluates the min and max of two values.


Suggested change

* Evaluates the min and max of two values.

* Evaluates the minimum and maximum values.

anandkaranubc · 2025-05-11T00:46:28Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+* @param x      First value
+* @param y      Second value
+* @param min    destination to store minimum value
+* @param max    destination to store maximum value


Suggested change

* @param max destination to store maximum value

* @param x first number

* @param y second number

* @param min destination to store the minimum value

* @param max destination to store the maximum value

anandkaranubc · 2025-05-11T00:47:42Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+* @param max    destination to store maximum value
+*
+* @example
+* #include <stdint.h>


There are no integers in the example. This can be removed

anandkaranubc · 2025-05-11T00:49:39Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+* double min;
+* double max;
+* stdlib_base_minmax( 3.14, NaN );
+* // returns [ NaN, NaN ]


No return. Function type is void.

anandkaranubc · 2025-05-11T00:52:25Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+#include "stdlib/math/base/special/minmax.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/assert/is_negative_zero.h"
+#include <stdlib.h>


This is not needed.

anandkaranubc · 2025-05-11T00:57:15Z

lib/node_modules/@stdlib/math/base/special/minmax/lib/native.js

+function minmax( x, y ) {
+	var out = new Float64Array( 2 );
+	addon( x, y, out );
+	return [ out[ 0 ], out[ 1 ] ];


Suggested change

return [ out[ 0 ], out[ 1 ] ];

return out;

anandkaranubc · 2025-05-11T00:57:38Z

lib/node_modules/@stdlib/math/base/special/minmax/lib/native.js

+*
+* @example
+* var v = minmax( 3.14, 4.2 );
+* // returns [ 3.14, 4.2 ]


Suggested change

* // returns [ 3.14, 4.2 ]

* // returns <Float64Array>[ 3.14, 4.2 ]

anandkaranubc · 2025-05-11T00:58:46Z

lib/node_modules/@stdlib/math/base/special/minmax/manifest.json

+        "@stdlib/napi/argv",
+        "@stdlib/napi/argv-double",
+        "@stdlib/napi/argv-float64array",
+        "@stdlib/napi/export",


These are not needed for examples/benchmark.

anandkaranubc · 2025-05-11T01:01:03Z

lib/node_modules/@stdlib/math/base/special/minmax/test/test.native.js

+
+	v = minmax( NaN, 3.14 );
+	t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' );
+	t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' );


Suggested change

t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' );

t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' );

Applies here and below.

anandkaranubc · 2025-05-11T01:03:13Z

lib/node_modules/@stdlib/math/base/special/minmax/include/stdlib/math/base/special/minmax.h

+#endif
+
+/**
+* Returns the minimum and maximum values.


Suggested change

* Returns the minimum and maximum values.

* Evaluates the minimum and maximum values.

The function doesn't return anything.

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

anandkaranubc · 2025-05-11T06:54:39Z

lib/node_modules/@stdlib/math/base/special/minmax/examples/c/example.c

+
+	for ( i = 0; i < 10; i++ ) {
+		stdlib_base_minmax( x[ i ], y[ i ], &min, &max );
+		printf( "x: %lf => min: %lf, y: %lf, minmax(x, y): %lf\n", x[ i ], y[ i ], min, max );


Suggested change

printf( "x: %lf => min: %lf, y: %lf, minmax(x, y): %lf\n", x[ i ], y[ i ], min, max );

printf( "x: %lf, y: %lf => min: %lf, max: %lf\n", x[ i ], y[ i ], min, max );

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

anandkaranubc · 2025-05-11T07:19:38Z

lib/node_modules/@stdlib/math/base/special/minmax/src/main.c

+#include "stdlib/math/base/assert/is_negative_zero.h"
+
+/**
+* Evaluates the minimum and maximum values in a single pass.


For the reviewers: I've updated the description, but if "Evaluates the minimum and maximum values." is sufficiently clear on its own, I will revert the changes.

Signed-off-by: Karan Anand <[email protected]>

feat: adding C implementation

19f604d

stdlib-bot added the Math Issue or pull request specific to math functionality. label Mar 22, 2025

Neerajpathak07 added 4 commits March 22, 2025 22:30

chore: updating manifest

bdac22d

chore: updating examples

bdc4609

chore: updating addon.c

c74f80c

chore: updating addon logic

c97d8f9

Neerajpathak07 added 2 commits March 22, 2025 23:28

chore: updating examples

55a3989

chore: updating addon

cca14c3

Neerajpathak07 commented Mar 22, 2025

View reviewed changes

Neerajpathak07 marked this pull request as ready for review March 22, 2025 18:26

stdlib-bot added the Needs Review A pull request which needs code review. label Mar 22, 2025

Neerajpathak07 added 2 commits March 23, 2025 18:35

chore: refactoring addon

f93e655

chore: CI errors

0e0ec54

stdlib-bot added the Potential Duplicate There might be another pull request resolving the same issue. label Apr 19, 2025

anandkaranubc self-requested a review May 11, 2025 00:34

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label May 11, 2025

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label May 11, 2025

Merge branch 'develop' into add-C-minmax

850edec

Signed-off-by: Karan Anand <[email protected]>

stdlib-bot added bot: In Progress Pull request is currently awaiting automation. and removed bot: In Progress Pull request is currently awaiting automation. labels May 11, 2025

anandkaranubc reviewed May 11, 2025

View reviewed changes

anandkaranubc self-requested a review May 11, 2025 06:29

anandkaranubc reviewed May 11, 2025

View reviewed changes

anandkaranubc previously approved these changes May 11, 2025

View reviewed changes

Update native.js

5adb76a

Signed-off-by: Karan Anand <[email protected]>

anandkaranubc dismissed their stale review via 5adb76a May 11, 2025 07:29

anandkaranubc previously approved these changes May 11, 2025

View reviewed changes

Update test.native.js

f8af36c

Signed-off-by: Karan Anand <[email protected]>

anandkaranubc dismissed their stale review via f8af36c May 11, 2025 07:37

anandkaranubc approved these changes May 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add C implementation for `math/base/special/minmax` #6296

feat: add C implementation for `math/base/special/minmax` #6296

Neerajpathak07 commented Mar 22, 2025

stdlib-bot commented Mar 22, 2025 •

edited

Loading

Neerajpathak07 Mar 22, 2025 •

edited

Loading

Neerajpathak07 Mar 22, 2025

Neerajpathak07 Mar 22, 2025 •

edited

Loading

gunjjoshi Mar 23, 2025

Neerajpathak07 Mar 23, 2025

Neerajpathak07 commented Mar 22, 2025

Neerajpathak07 commented Mar 23, 2025

anandkaranubc commented May 11, 2025

stdlib-bot commented May 11, 2025

anandkaranubc commented May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025

anandkaranubc May 11, 2025 •

edited

Loading

	* Evaluates the min and max of two values.
	* Evaluates the minimum and maximum values.

-* @param max    destination to store maximum value
+* @param x      first number
+* @param y      second number
+* @param min    destination to store the minimum value
+* @param max    destination to store the maximum value

	* // returns [ 3.14, 4.2 ]
	* // returns <Float64Array>[ 3.14, 4.2 ]

	t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' );
	t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' );

	* Returns the minimum and maximum values.
	* Evaluates the minimum and maximum values.

	printf( "x: %lf => min: %lf, y: %lf, minmax(x, y): %lf\n", x[ i ], y[ i ], min, max );
	printf( "x: %lf, y: %lf => min: %lf, max: %lf\n", x[ i ], y[ i ], min, max );

feat: add C implementation for math/base/special/minmax #6296

Are you sure you want to change the base?

feat: add C implementation for math/base/special/minmax #6296

Conversation

Neerajpathak07 commented Mar 22, 2025

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Mar 22, 2025 • edited Loading

Coverage Report

Neerajpathak07 Mar 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Neerajpathak07 Mar 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Neerajpathak07 commented Mar 22, 2025

Neerajpathak07 commented Mar 23, 2025

anandkaranubc commented May 11, 2025

stdlib-bot commented May 11, 2025

anandkaranubc commented May 11, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anandkaranubc May 11, 2025 • edited Loading

Choose a reason for hiding this comment

feat: add C implementation for `math/base/special/minmax` #6296

feat: add C implementation for `math/base/special/minmax` #6296

stdlib-bot commented Mar 22, 2025 •

edited

Loading

Neerajpathak07 Mar 22, 2025 •

edited

Loading

Neerajpathak07 Mar 22, 2025 •

edited

Loading

anandkaranubc May 11, 2025 •

edited

Loading